Cream of the Crop 25

home *** CD-ROM | disk | FTP | other *** search

/ Cream of the Crop 25 / Cream of the Crop 25.iso / bbs / outil179.zip / OPUS-FAM.DOC < prev next >

Wrap

Text File | 1997-04-30 | 33KB | 757 lines

OOOOOOOOOOO PPPPPPPPPPPP UUUU UUUU SSSSSSSSSSS OOOOOOOOOOOOO PPPPPPPPPPPPP UUU UUU SSSSSSSSSSSSS OOO OOO PPP PPP UUU UUU SSS S OOO OOO PPP PPP UUU UUU SSS OOO OOO PPP PPP UUU UUU SSS OOO OOO PPPPPPPPPPPPP UUU UUU SSSSSSSSSSSS OOO OOO PPPPPPPPPPPPP UUU UUU SSSSSSSSSSSS OOO OOO PPP UUU UUU SSS OOO OOO PPP UUU UUU SSS OOO OOO PPP UUU UUU S SSS OOOOOOOOOOOOO PPPP UUUUUUUUUUUUU SSSSSSSSSSSSS OOOOOOOOOOO PPPPP UUUUUUUUUUU SSSSSSSSSSS OPUS-FAM A File Area Manager for the Opus CBCS and other compatible BBS systems Version - 90 July 5,1991 Written By: Doug Boone 119/5 John Valentyn 114/18 Documentation By: Jim Harre 100/55 Pat Collins 114/18.21 FFFFFFFFFFFFF AAAAAAAAAAAAA MMM MMM FFFFFFFFFFFFF AAAAAAAAAAAAA MMM MMM FFF F AAA AAA MMMM MMMM FFF AAA AAA MMMMM MMMMM FFF AAA AAA MMM MM MM MMM FFFFFFFFFF AAAAAAAAAAAAA MMM MM MM MMM FFFFFFFFFF AAAAAAAAAAAAA MMM MMM MMM FFF AAA AAA MMM M MMM FFF AAA AAA MMM MMM FFF AAA AAA MMM MMM FFFFF AAAAA AAAAA MMMMM MMMMM FFFFFFF AAAAAAA AAAAAAA MMMMMMM MMMMMMM Table Of Contents MAJOR FEATURES INCLUDE: 2 STARTUP - The Configuration File 2 COMMAND line options 3 THE SCREEN 4 SCREEN COMMANDS 4 4 -) Up (Ctrl-E) 4 +) Down (Ctrl-X) 4 Right (Ctrl-D) 4 Left (Ctrl-S) 4 Backspace (Ctrl-G) 4 Insert (Ctrl-V) 4 <) PageUp (Ctrl-R) 4 >) PageDown (Ctrl-C) 4 Home (Ctrl-W) 4 End (Ctrl-Z) 4 4 J)ump 5 E)dit Descrip. 5 T)ag/untag 5 U)ntag 5 A)dopt/Aban. 5 G)rab All 5 S)ort 5 Z)ap 6 F)ind/Locate 6 D)elete 6 ^K 6 K)ill Tagged 6 I)nsert 6 C)opy/M)ove 6 R)ename 7 V)iew ARC 7 L)ist Text 7 B) Date 7 ^B 7 W) Raw Dir 7 Q)uit/Save 8 ESC)Don't Save 8 ") Ditto 8 ?)Inform 8 X)xtra file 8 Y)Zap line 8 appendix a 9 STARTUP - The Config File 9 OPUS Version 9 Video Display 9 Privileges 9 Appendix B 11 Section B-1 11 Section B-2 11 Appendix C (sample Config.file) 12 WHATZIT? OPUS-FAM is a utility to manage your files areas, somewhat similar to Fido-Fam. It sports quite a number of features and should make your life as an Opus Sysop easier. OPUS-FAM and a bottle of Anacin-3 could also make some of your headaches disappear (maybe). MAJOR FEATURES INCLUDE: * Shows the contents of ARC, PAK, LZH, LHA, ZIP and ZOO files. * Can set archive file date to date of the most recent file inside the archive (neat, Huh?). * Expands wildcard listings. * Attempts to eradicate any pesky ^Z's found. * Runs locally or remotely as you prefer. * Runs through your FOSSIL if it can. Includes X00 hllapi routines which should now be fossil independent. * Allows the Sysop to configure for Assistant Sysops to have LIMITED access to areas. * Creates paginated file listings in several formats with custom page headers. * Source code will be available once we get a released version so others can add new goodies. * Allows embedded OECL video codes. * Allows single or multiple copies and moves within an area or across areas. * Puts the dog out at night and starts the coffee maker in the morning before you get up. (I some undefined future release, will possible be hardware dependent though.) INSTALLATION Completely read the documentation including any readme files that may be provided before using OPUS-FAM. Install OPUS-FAM in the OPUS HOME DIRECTORY or inform OPUS-FAM where the OPUS HOME DIRECTORY is located with the OPUS environment variable. Modify the OPUS-FAM configuration file to meet your system requirements. THE CONFIGURATION FILE OPUS-FAM uses a configuration file to get most of its options. You'll need to go through and edit the sample OPUS-FAM.CFG included (at no extra charge) before running the program. Most of the information in the configuration file is well commented, but if you want some more information refer to Appendix A. COMMAND LINE OPTIONS The syntax for the OPUS-FAM command line is as follows: (Refer to Appendix B for command line examples and explanations.) OPUS-FAM [-option] [-option] [config file name] OPTIONS -25 Use EGA 25 line mode. -43 Use EGA 43 line mode. -a2 Go directly to file area 2 and exit to dos when done. -b#### Use baud rate #### when running remotely.* -c my_cnfg.cfg Use my_confg.cfg instead of OPUS-FAM.CFG -d Lower DTR from keyboard (only if no carrier)! -l Produce FILE lists according to your config file. -k Run from Keyboard mode and use BIOS screen writes. -p# Set which comm port to use when running remotely. The default is port 0.* -v Use ANSI screen writes instead of BIOS. -w Turn FOSSIL Watchdog on if running remotely. NOTE (* These options are normally passed to OPUS-FAM when invoked by OPUS.) THE SCREEN Since most of your time will be spent starting at the display, let's look at what you will be looking at most of the time. +--------------------------------------------------------------------------+ |Area: 12 LAN Line: 0 | | | |--------------------------------------------------------------------------| |BRGCOM.ZIP 127401 01-08-91 Async bridge software for Novell. | |EM2000.ZIP 53113 01-11-91 Network message program for Novell. | |0TALK1.ZIP 153003 01-23-91 Message mail utility for Novell. | |--------------------------------------------------------------------------| |-)Up +)Down <)Page up >)Page Down J)ump E)ditDescrip | |T)ag/untag U)ntag all A)dopt/Aban. G)rab All S)ort F)ind/locate | |D)elete K)ill Tagged I)nsert C)opy M)ove R)ename | |V)iew ARC L)ist Text B)date W(Raw Dir Q)uit/Save ESC)Don'tsave | |")Ditto ?)Inform X)xtra file Y)zap line Z)ap file | +--------------------------------------------------------------------------+ The very top line on the display shows the area number that has been selected, the area name (from your FILES.BBS) and the current line number. Normally the current line is shown in reverse video unless you have changed the video options, and is called the bar. Just to the right of the line number is the STATUS AREA. When MOVE or COPY is invoked, this area is used to help keep things straight. Below that, OPUS-FAM list 14 lines out of your FILES.BBS. Text lines and file lines display just as you would expect to see them from OPUS. File lines show the file names, size in bytes, file date 9if enabled) and the file description. At the bottom of your screen, are the available commands. Depending on the options you take, the bottom will change for COPY and MOVE. The function of each command is as follows: SCREEN COMMANDS -) Up (Ctrl-E) +) Down (Ctrl-X) Right (Ctrl-D) Left (Ctrl-S) Backspace (Ctrl-G) Insert (Ctrl-V) <) PageUp (Ctrl-R) >) PageDown (Ctrl-C) Home (Ctrl-W) End (Ctrl-Z) Running remotely, the first four commands move the BAR around on the screen. If you are running locally, they will work as well as the regular cursor movement keys. For remote use, the numbers on the keypad will correspond with moving the cursor around. For example, '7' will have the same effect as hitting the Home key. This is primarily intended to help remote users. Obviously, you can't use the numbers when you're editing a description or comment. Instead use ^S (move left), ^D (move right), ^A (beginning of line), or ^F (end of line). J)ump Jump can be used to move the BAR to any line in the file. If you Jump to a line number past the end of the file, the BAR is placed on the last line and the display is updated accordingly. E)dit Descrip. Used to edit either a file description or a text line, EDIT will place the cursor on the first available spot on the line where the BAR rests. The bar or window will "slide" left or right. Max of 512 characters. If you edit the description of an orphan file, the file will be automatically adopted. T)ag/untag Will toggle tagging on and off and is used in several places. For COPY and MOVE, allows marking one or more lines for mass operations. Tagged lines show a double greater-than sign in front of the file name. This is handy for moving newly uploaded files that show up at the bottom of your FILES.BBS to the areas where they belong. Tagged lines are also used to MOVE or COPY to other file areas. U)ntag Untag will remove tags from all tagged lines. A)dopt/Aban. Orphans will show up in your FILES.BBS when a user fails to give Opus a description after uploading, or if you use the DOS copy function to place a file in an area. In either case, there is no description for the file. Adopt will place '** No Description **' in the description area and allow you to change it. Hitting 'A' again will orphan the line and wipe out the description. G)rab All Grab All will adopt all orphans in the file and alleviate the single line 'adopt and edit' syndrome. S)ort Allows the file names to be sorted in either alphabetical order or by file date, in either ascending or descending order. Specify the first and last line to be sorted, any comment lines appearing after file names will remain with that filename. Z)ap Zap deletes a file, but retains its listing and marks it as 'MISSING'. Why would you want to do that? Suppose you have an update for Binkley Term in your inbound mail directory so you M)ove it over to your Binkley area. Now you have two files and one listing. You could D)elete the old file and listing, A)dopt the new file, put a description on it, and put it where you think it belongs in FILES.BBS by hand. Or, you could Z)ap the old BEXE_???.ARC and R)ename the old listing to the new name. Automatically, OPUS-FAM will know that you're talking about the new file and everything will be left in place, saving you some steps when adding updates. F)ind/Locate Searches file names and descriptions for specified text.You are requested to enter text for the search and are rewarded with either found or not found messages.When found, the message: Match found: A)ccept, C)ontinue, R)everse is displayed at the bottom of the screen. A)ccept causes the search to stop; C)ontinue keeps looking; and R)everse causes the search to head in the opposite direction. Normally F)ind looks from top to bottom of your FILES.BBS. If you F)ind a string and want to work backwards (bottom to top), using R)everse does the trick. D)elete Wipe out the file on the current line. D)elete will ask you to confirm that you really want to delete the file. If you answer 'y', the file and the FILES.BBS entry are history. On text only lines, the line is deleted without asking. ^K Control-K (^K) assumes you know what you are doing - it wipes the file without asking questions. It will not kill a text only line. K)ill Tagged Also known as Ghengis Kahn, kills all tagged lines. Two options are presented at the bottom of the screen when this is invoked -- 'C' to confirm deletion of each tagged line, and 'G' to Go-for-the-whole-thing. That is, "don't bother me - just get rid of all this junk". Not for the faint hearted or absent minded, all previously tagged lines are deleted and no questions are asked. Text only lines are not confirmed - just killed. I)nsert Inserts a blank line above the cursor position. C)opy/M)ove Copy and Move, the hard working non-identical twins have LOTS of options. You can tag files in your area to move to other areas, copy to other areas, or handle each file individually. When you hit the C)opy or M)ove commands OPUS-FAM will change the menu at the bottom of the screen to show what commands you can use. You can toggle on and off whether you are moving/copying individual files or want to handle all the tagged files in that area. You can also toggle whether you are copying/moving within this area or if you're going to put the files in a different area. The status area in the top right corner of your screen shows what you've set. If you are working across areas, a full area menu is presented so you can select where you want to send the file(s). When moving across areas, C)opy will leave the original file(s) intact while M)ove will copy the file(s) and C)opy and M)ove can be a little confusing at first, so here's a step-by-step explanation: R)ename Nothing terribly exciting here. Just like the DOS R)ename command except your FILES.BBS is automatically updated with the new name. V)iew ARC More aptly, V)iew ARC/LZH/PAK/ZIP/ZOO except all that won't fit on your display. This command will search the archived file and present to you a list of its contents. Other pertinent information such as dates, actual and compressed sizes, and other good stuff are also displayed. Note that we aren't unpacking these - just snooping around to see what's in there. L)ist Text While rare these days, text files are uploaded. This option allows you to L)ist a text file to the screen. You are presented with a screen-full of text and the options of 'More? [Y,n,=]'. Hitting <ENTER> or 'y' will send the next page to the display. 'N' will quit the listing, and '=' will list the rest of the file without stopping to ask more silly questions. B) Date These commands allow you to change the 'birthdate' of the file. Normally your files contain the date that the file was uploaded. Using 'B' will set the date to today's date. ^B Control-B is a little sneakier - it will search through an archive file (.ARC, .LZH, .PAK, .ZIP or .ZOO) to find the date of the most recent file in the archive and change the file date to that date. Note that you may wish to give some thought to your own personal file dating philosophy before using these commands. When a user displays a file area list, Opus will flag files with an asterisk when the file's date is newer than the user's last logon. If you start mucking around with the dates, you could get everyone (including yourself) confused. W) Raw Dir When you need just a plain DOS-style directory, this is what to use. You are prompted for the directory name and a file mask. If you specify a directory, it must be specified with the full path. For example: Enter directory name: h:\pc-util File name mask (none=all): *.exe will go out to drive H:, subdirectory \pc-util, and present a list of all .EXE files. Q)uit/Save Very cryptic, this one. Don't forget to use it, however. All those painstaking changes will be lost unless you Q)uit and Save your work. ESC)Don't Save Quit the current operation - DON'T save changes. Very handy when you've fouled up your areas.bbs beyond all human recognition. It leaves the files.bbs for the area as it was when you started, but if you deleted any files, they're gone. If you move any files , they're wherever you moved them. ") Ditto (copy) the description from the line above the current line. ?)Inform Displays configuration information X)xtra file Y)Zap line Deletes the file description, but leaves the file. Handy for those files that end up in the list more than once. APPENDIX A STARTUP - The Config File OPUS-FAM uses a configuration file to get most of it's options. You'll need to go through and edit the sample OPUS-FAM.CFG included (at no extra charge) before running the program. Most of the information in the config file is well commented, but we'll hit the highlights here. To make an option active, remove the semicolon from the beginning of the line. To disable a line, add a semicolon to the beginning of the line. OPUS Version We need to know which version of Opus you are using. Currently, version 1.03 and 1.10 are supported. The primary difference is that the SYSTEMxx.BBS files. In version 1.03, the 'xx' is decimal; in 1.10 it is hexadecimal numbering. Alternatively, you can tell us you want to specify the drives and paths to your FILES.BBS's by using the SCAN areas. This method has a few other advantages. You can use this method with Opus 1.03, Fido, or just about any other system that uses the FILES.BBS concept. Plus it's faster having the areas and paths in the config file we don't have to go out and dig all this up from your system files. Video Display This is where you tell OPUS-FAM how to handle the display. For local use, you can either use 'local bios' for fast screen updates, 'local ibm' for VERY fast screen updating on very IBM compatible machines, or for not-so-compatibles, use 'local ansi'. You also tell us whether you use a color or mono display. When running remotely, you can specify the use of either ANSI mode(available in most good communications programs) or AVATAR which is sported by a select few speed conscious packages. As with local, tell us whether to send color info or stick with good ol' mono. If you select color, a myriad of colors are configurable for most areas of the display. Privileges When you allow others to use Opus-Fam, you can restrict their activities depending on the privilege level set up for them in Opus. Accepted levels are: Twit, Disgrace, Normal, Privil, Extra, Assist, Sysop, and Hidden. The Opus-Fam keywords are: priv_kill - kill a file priv_area - change areas priv_adopt - adopt orphan files priv_rawdir - view raw directory For example, if your config file is set up as: priv_kill assist priv_area extra priv_adopt assist priv_rawdir assist a user with an ASSIST privilege level could use all of these commands. A user with a priv level of EXTRA could only change areas. APPENDIX B SECTION B-1 The following is examples of some of the command options that may be used with OPUS-FAM. EXAMPLE #1: OPUS-FAM -k -d -c myconfig.cfg The above example would inform OPUS-FAM to run in local mode (-k), to lower DTR (-d) and to use an alternate config. file (-c my_cnfg.cfg). EXAMPLE #2: OPUS-FAM -l Example #2 could be used from a batch file to produce file list as described in the config. file. SECTION B-2 The following is examples of the Copy/move instructions and handling procedures. Copy/Move line within an area: 1) Find the line to copy, put the bar on it. 2) Hit 'C' to copy or 'M' to move the line. 3) Move the BAR to the location where the lines should be copied. 4) Hit <ENTER> Copy/Move multiple lines within an area: 1) Tag lines you want to copy. 2) Hit 'C' to copy or 'M' to move the lines. 3) Move bar to the location where lines should be copied. 4) Hit 'T' (copy Tagged lines). 5) Hit <ENTER> Copy/Move line across areas: 1) Find the line to copy, put the bar on it. 2) Hit 'C' to copy or 'M' to move the line. 3) Hit 'A' to copy to another area. 4) Hit <ENTER> 5) Chose the area where you want the file copied. Copy/Move multiple lines across areas: 1) Tag the lines you want to copy. 2) Hit 'C' to copy or 'M' to move. 3) Hit 'A' to copy to another area. 4) Hit 'T' to work with Tagged lines. 5) Hit <ENTER> 6) Chose the area where you want the files copied. APPENDIX C (sample Config.file) ; sample configuration file for Opus-FAM ver 0.70 ; search rules for the config file. ; 1. current directory ; 2. path in environment string "set opus-fam=d:\dir" ; 3. Optional command line switch -c d:\dir\opus-fam.cfg ; begin opus-fam ; ; The very first thing we have to know here is which version of Opus ; you are running. Two version are currently supported: ;Opus 1.03 Opus 1.10 ; ; Local Keyboard ; local mono ; User doesn't have color ; local color ; User wants color locally ; ; local ANSI ; Use ANSI.SYS driver for screen control ; local bios ; Write through BIOS. Faster. local ibm ; Write directly to metal. FAST, but must be compatible! ; ; Will return to original state after use if you use these. ; ; ega 43 ; Use 43 line mode with EGA/VGA ; ega 25 ; Use 25 line mode with EGA/VGA ; ; For REMOTE operations! ; ; remote mono remote color ; remote ansi ; remote AVATAR ; ; you don't have to run Opus-FAM in the Opus home directory, ; but if you don't, you must tell Opus-FAM where the Opus ; home directory is. ; ;root <path> designates the Opus home directory (where the ; system??.dat files reside). The preferred now is to use the OPUS Environment variable. ; ; for those of you with lan's, where you might want to run Opus-FAM ; from another node, use the assign statement to remap the server ; partition names to the parting names on your node. ; ;assign [x] = [y] ; x is the drive designated in the system??.dat files ; y is the drive to be remapped to ; Note: up to 24 assign statements can be specified ; ; ; Next we need to know a little bit about your environment and options ; for file area management ; ; Defaults are: kill on Assist privilege ; adopt on Assist privilege ; areas on Assist privilege ; rawdir on Assist privilege ; user_priv SYSOP ; backup on ; ; Accepted privilege levels are: ; Opus 1.03 Opus 1.10 ; --------- --------- ; twit Twit ; disgrace Disgrace ; normal Limited ; privil Normal ; extra Worthy ; assist Privil ; sysop Favored ; hidden Extra ; Clerk ; Assist ; Sysop ; Hidden ; priv_kill assist ; user with "assist" privilege can kill files priv_area extra ; user with "extra" privilege can change areas priv_adopt norm ; user with "normal" privilege can adopt orphan files priv_rawdir priv ; "privilege" user can do a Raw dir priv_abandon assist ; "assist" user can abandon files ; backup no ; user wants the files.bbs copied to files.bak trim no ; trim looonnnggg description lines ; show_date ; controls whether or not to display file dates ; The default is mm-dd-yy. ; If you specify the month as 3 positions, the first 3 chars of the month ; will be used, i.e. mmm-dd-yy would show Jan-15-91. The year can be 4 ; positions, i.e. dd/mm/yyyy would show 15/01/1991. ; ; ; If you specify a log file name, then all errors encountered during ; file list processing will be entered in the log. This feature is ; highly recommended when Opus-FAM is invoked from a batch file during ; automatic processing. ; ;log c:\opus\error.log ; ; ; We are using the same color names and format as used by oecl, George ; Stanislav's great opus embedded command language compiler ; ; The following colors can be used for both foreground and background: ; black ; blue ; green ; cyan ; red ; magenta ; brown ; gray ; ; Now the colors that can be used for the foreground only. ; darkgray ; lightblue ; lightgreen ; lightcyan ; lightred ; lightmagenta ; yellow ; white ; ; There two more reserved words dealing with colors: ; on ; blink ; ; Colors can be configured for the following items: ; menu-select yellow on blue ; the selection character on menus menu-text cyan on black ; the selection text on menus edit-line red on cyan ; the line being edited status-bar white on green ; status line functions ; ; ; Define the headers for the list. Up to three headers may be defined. ; headers are automatically centered, and may appear on the first ; page of the list file, each page, or not at all. ; Unless they are extremely long, they will work ; even for a sorted list, since the left margin where the file names ; normally appear will be spaces, and therefore sort first. ; The definitions stay intact (carry forward) for each file requested ; first we show the flexibility of generating different files lists, all ; from 1 invocation of Opus-FAM. In my nightly maintenance, I generate ; three file lists. priv_list sysop ; only list areas below sysop level missing yes ; print missing files zero yes ; print files with 0 lengths downloads yes ; print # of times files downloaded uploader yes ; print uploader name HDR1 *LAZARUS* HDR2 OpusInfo Sherwood HDR3 Master File List by Area lpp 62 ; Lines per page (default is 62) column 80 ; page width (max is 136, default is 80) print_date mm-dd-yy ; controls whether or not to print file dates ; The default is mm-dd-yy. ; If you specify the month as 3 positions, the first 3 chars of the month ; will be used, i.e. mmm-dd-yy would show Jan-15-91. The year can be 4 ; positions, i.e. dd/mm/yyyy would show 15/01/1991. quiet yes ; supress progress reports during the file list processing totals yes ; print totals in the output file sorted no ; produce file by area (default) ; options to print headers ; headup once ; on the first page of the output file, ; page ; on each page of the output file, ; none ; or no headers at all. ;wrap yes ; wrap long lines wrap no ; truncate long lines ;strip yes ; strip ANSI escape sequences strip no ; converts to printable characters comments yes ; print file comments (has no affect if sort option selected) ;comments no ; don't print any comments from the files.bbs level sysop ; Any lines marked with the AVATAR sequence "below ... don't ; see rest of file" or "rest of line" will be skipped in the ; list file (same as Opus F)iles command). ; The above listed options carry forward for each report. ; AREA/XAREA need to be set for each report produced ; They are also mutually exclusive. Which means that you either ; specify the areas desired for the report, or you specify all areas ; EXCEPT those listed for that report. ; ;AREA 1 2 3 4 5 6 7 8 XAREA 0 20 40 51 81 80 82 file d:\files\bbstext\Lazarus.lst ; produce first report ; Set up the parameters for the second report, which is a sorted file ; list. Opus-FAM doesn't do the actual sort since there are many excellent ; file sorters available. Here's the command line from my bat file ; sortf sortin.lst H:\file\f01\sorted.lst /+4,14 (for Opus 1.03) ; sortf sortin.lst H:\file\f01\sorted.lst /+5,15 (for Opus 1.10) HDR3 Sorted Master File List sorted ; produce sorted file totals no XAREA 0 50 51 99 file H:\temp\sortin.lst ; produce second report ; execute a dos command - note that the entire line is passed to %comspec% exec sortf H:\temp\sortin.lst H:\file\f01\sorted.lst /+4,14 ; The third report is my WOCCFILES. It contains just those file areas ; with BBS related files HDR3 File List of BBS software only area 23 24 25 27 sorted no totals no file H:\temp\wocfiles.lst ; produce third report ; make a list of all the new files HDR3 Files newer than 14 days XAREA 0 50 51 99 sorted no totals no newfile H:\file\f01\newfiles.lst 14 ; produce fourth report end opus-fam ; the end .Begin Table C. .End Table C.